socketio/dev.adven.sockit.api/[common]SocketOptionsBuilder

SocketOptionsBuilder

Constructors

constructor()

Properties

Timeout for a pending NamespaceSocket.emitWithAck acknowledgement, in milliseconds. 0 (default) disables the timer; the pending ack is still failed if the connection drops, so it never hangs indefinitely. When > 0, the flow fails with SocketError.Timeout if no ACK arrives in time.

eventBufferCapacity

var eventBufferCapacity: Int

eventBufferOverflow

var eventBufferOverflow: EventBufferOverflow

experimentalWebTransport

var experimentalWebTransport: Boolean

When true, Transports.WEBTRANSPORT is accepted in transports and the internal factory registers a stub transport (opens fail until platform WebTransport is implemented).

forceNew

var forceNew: Boolean

httpClient

var httpClient: HttpClient?

logger

var logger: Logger

multiplex

var multiplex: Boolean

path

var path: String

randomizationFactor

var randomizationFactor: Double

reconnection

var reconnection: Boolean

reconnectionAttempts

var reconnectionAttempts: Int

reconnectionDelayMaxMs

var reconnectionDelayMaxMs: Long

reconnectionDelayMs

var reconnectionDelayMs: Long

timeoutMs

var timeoutMs: Long

trustAllCerts

var trustAllCerts: Boolean

upgrade

var upgrade: Boolean

Functions

auth

fun auth(block: JsonObjectBuilder.() -> Unit)

Sets the auth payload sent in the Socket.IO CONNECT packet, using kotlinx.serialization's JsonObjectBuilder DSL so values may be strings, numbers, booleans, or nested objects:

extraHeaders

fun extraHeaders(block: MutableMap<String, List<String>>.() -> Unit)

transports

fun transports(vararg names: String)